<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>sipML5: convention</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="sipml-45x51.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">sipML5
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">World&#39;s first HTML5 SIP Client</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div>
<div class="header">
  <div class="headertitle">
<div class="title">convention </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>As you probably now javascript is not a strongly typed language and it's bit hard to get the type of an object while programing. To make your life easier we adopted a convention in the naming of the variables and functions. </p>
<h2>Prefixes</h2>
<ul>
<li><b>e_</b>: Enumeration <div class="fragment"><pre class="fragment"> var e_state = states_e.START; 
</pre></div></li>
<li><b>f_</b>: Floating point number <div class="fragment"><pre class="fragment"> f_density = 0.5; 
</pre></div></li>
<li><b>i_</b>: Integer number <div class="fragment"><pre class="fragment"> var i_index = 1; 
</pre></div></li>
<li><b>o_</b>: Object created using new() <div class="fragment"><pre class="fragment"> var o_stack = <span class="keyword">new</span> tsip_stack_t(...); 
</pre></div></li>
<li><b>ao_</b>: Array of Objects <div class="fragment"><pre class="fragment"> var ao_stacks = <span class="keyword">new</span> Array(); 
</pre></div></li>
<li><b>on_</b>: Callback function pointer <div class="fragment"><pre class="fragment"> o_stack.on_event = <span class="keyword">function</span>(e){}; 
</pre></div></li>
<li><b>s_</b>: String <div class="fragment"><pre class="fragment"> var s_uri = <span class="stringliteral">&#39;sip:alice@doubango.org&#39;</span>; 
</pre></div></li>
<li><b>as_</b>: Array of strings <div class="fragment"><pre class="fragment"> var ao_uris = <span class="keyword">new</span> Array();
Please note that <span class="keyword">static</span> variables are prefixes by <span class="stringliteral">&quot;__&quot;</span> followed by the type e.g. @code var __i_timeout = 1800; 
</pre></div> <h2>Sufixes</h2>
</li>
</ul>
<ul>
<li><b>_t</b>: An object type which could be created using 'new' keyword.</li>
<li><b>_e</b>: Enumeration type.</li>
<li><b>_f</b>: Variable defining a function (like C/C++ function pointers or CSharp delegates) </li>
</ul>
</div></div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Wed May 16 2012 23:47:02 for sipML5 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>

</body>
</html>
